Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding NuGet logo and README support #5183

Merged
merged 6 commits into from
Nov 10, 2021

Conversation

Aaronontheweb
Copy link
Member

Working on trying to implement https://devblogs.microsoft.com/nuget/add-a-readme-to-your-nuget-package/ but my MSBuild-foo is not yet strong enough....

@Aaronontheweb
Copy link
Member Author

NuGet package stage worked on the build server. I'll have to retry doing that locally.

@Aaronontheweb
Copy link
Member Author

Looks like the build system fails on my machine due to NuGet/Home#10791 - can't include the README file with our NuGet package until snupkg adds support for it. Otherwise, we lose SourceLink support - which is more useful and valuable than a README in the NuGet package.

@Aaronontheweb
Copy link
Member Author

This doesn't fail on the build server because it uses an older version of the .NET 5 SDK than I do on my development machine.

Server: 5.0.101
My machine: 5.0.300

@Aaronontheweb
Copy link
Member Author

In theory, I could split the snupkg and nupkg publication into two different discrete steps and manually pass in a flag to disable the PackReadmeFile variable but I think I'd rather just wait for a fix.

@Aaronontheweb
Copy link
Member Author

NuGet/Home#10791 (comment) - need to upgrade to the .NET 6.0 runtime to resolve this issue.

@Aaronontheweb
Copy link
Member Author

For reasons I don't fully understand, NuGet pack now appears to be working....

@Aaronontheweb Aaronontheweb marked this pull request as ready for review October 14, 2021 13:34
@Aaronontheweb
Copy link
Member Author

Let's test this out now that we've merged in #5373

@Aaronontheweb Aaronontheweb merged commit 7ba59b4 into akkadotnet:dev Nov 10, 2021
@Aaronontheweb Aaronontheweb deleted the nuget/readme-support branch November 10, 2021 22:22
@Aaronontheweb
Copy link
Member Author

This now works properly on .NET 6! Going to update our README.md to be a little more NuGet-friendly in a subsequent issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant